<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>uartns550: xuartns550_polled_example.c File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">uartns550
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="pages.html"><span>Examples</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('xuartns550__polled__example_8c.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">xuartns550_polled_example.c File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
<div class="textblock"><p>This file contains a design example using the Uart 16450/550 driver (<a class="el" href="struct_x_uart_ns550.html" title="The XUartNs550 driver instance data. ">XUartNs550</a>) and hardware device using polled mode. </p>
<p>MODIFICATION HISTORY: </p>
<pre>
Ver   Who  Date     Changes
</p>
<hr/>
<p>
1.00a jhl  02/13/02 First release
1.00b ecm  01/25/05 Modified for TestApp integration, updated boilerplate.
1.00b sv   06/08/05 Minor changes to comply to Doxygen and coding guidelines
2.00a ktn  10/20/09 Updated to use HAL processor APIs and minor modifications
              as per coding guidelines.
              Updated this example to wait for valid data in receive
              fifo instead of Tx fifo empty to update receive buffer
3.4   ms   01/23/17 Added xil_printf statement in main function to
                    ensure that "Successfully ran" and "Failed" strings
                    are available in all examples. This is a fix for
                    CR-965028.
3.9   gm   07/09/23 Added SDT support
</pre> </div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a9703337f126b36fb11bd36ab465ea54d"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xuartns550__polled__example_8c.html#a9703337f126b36fb11bd36ab465ea54d">UartNs550PolledExample</a> (u16 DeviceId)</td></tr>
<tr class="memdesc:a9703337f126b36fb11bd36ab465ea54d"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function does a minimal test on the UART 16450/550 device and driver as a design example.  <a href="#a9703337f126b36fb11bd36ab465ea54d">More...</a><br/></td></tr>
<tr class="separator:a9703337f126b36fb11bd36ab465ea54d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a840291bc02cba5474a4cb46a9b9566fe"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xuartns550__polled__example_8c.html#a840291bc02cba5474a4cb46a9b9566fe">main</a> (void)</td></tr>
<tr class="memdesc:a840291bc02cba5474a4cb46a9b9566fe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Main function to call the example.  <a href="#a840291bc02cba5474a4cb46a9b9566fe">More...</a><br/></td></tr>
<tr class="separator:a840291bc02cba5474a4cb46a9b9566fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="a840291bc02cba5474a4cb46a9b9566fe"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int main </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Main function to call the example. </p>
<p>This function is not included if the example is generated from the TestAppGen test tool.</p>
<dl class="section return"><dt>Returns</dt><dd>XST_SUCCESS if successful, otherwise XST_FAILURE.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="xuartns550__polled__example_8c.html#a9703337f126b36fb11bd36ab465ea54d">UartNs550PolledExample()</a>.</p>

</div>
</div>
<a class="anchor" id="a9703337f126b36fb11bd36ab465ea54d"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int UartNs550PolledExample </td>
          <td>(</td>
          <td class="paramtype">u16&#160;</td>
          <td class="paramname"><em>DeviceId</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function does a minimal test on the UART 16450/550 device and driver as a design example. </p>
<p>The purpose of this function is to illustrate how to use the <a class="el" href="struct_x_uart_ns550.html" title="The XUartNs550 driver instance data. ">XUartNs550</a> component.</p>
<p>This function sends data and expects to receive the data through the UART using the local loopback mode of the UART hardware.</p>
<p>This function polls the UART and does not require the use of interrupts.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">DeviceId</td><td>is the XPAR_&lt;uartns550_instance&gt;_DEVICE_ID value from xparameters.h.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>XST_SUCCESS if successful, XST_FAILURE if unsuccessful.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>This function polls the UART such that it may be not return if the hardware is not working correctly. </dd></dl>

<p>References <a class="el" href="group__uartns550.html#ga120797e7b4fc719c827c4378e387efe4">XUartNs550_GetOptions()</a>, <a class="el" href="group__uartns550.html#ga97009bf7b2508c14225b0d5835c256d0">XUartNs550_Initialize()</a>, <a class="el" href="group__uartns550.html#ga35fc171801e394fce29cbcb09dc1ff99">XUartNs550_Recv()</a>, <a class="el" href="group__uartns550.html#ga2ec86252a3b83b8d7b4815ffb960562d">XUartNs550_SelfTest()</a>, <a class="el" href="group__uartns550.html#ga421921af6a8df7c51ddbfa5d2301ad1b">XUartNs550_Send()</a>, <a class="el" href="group__uartns550.html#gac2270082fbb7d7b2c32bd9208dae5be3">XUartNs550_SetOptions()</a>, <a class="el" href="group__uartns550.html#ga9bd45da1706d1d6cfc0f22d4fca46100">XUN_OPTION_FIFOS_ENABLE</a>, and <a class="el" href="group__uartns550.html#gaaf47eddf3f91b4dfea5fa70849ccf094">XUN_OPTION_LOOPBACK</a>.</p>

<p>Referenced by <a class="el" href="xuartns550__polled__example_8c.html#a840291bc02cba5474a4cb46a9b9566fe">main()</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
